Go to QuArK Web Site
Eclipse CVS client
Updated 06 Nov 2004
Upper levels:
QuArK Information Base
4. The Source Code
4.1. The CVS repository at Sou...

 4.1.1. Eclipse CVS client

 [ Prev - Up - Next ] 

This is Rowdy's guide to configuring Eclipse to access the QuArK CVS repository.


 Index


 Program Links

Rowdy / cdunde - 06 Nov 2004   [ Top ] 

First, you will need to download and install Java 2 Platform (http://java.sun.com/j2se/1.4.2/download.html). You will only need the Runtime Environment version rather than the full SDK version. This program basically installs itself , so no configuration instructions are really needed here.

Then download and install Eclipse (http://www.eclipse.org/downloads/index.php). You only need one file, for Eclipse 3.0 this would be eclipse-SDK-3.0-win32.zip. It is a zip file so you need a utility like WinZip. The default and generally recommended directory to extract it to is c:\eclipse.


 Installation & Configuration

Rowdy / cdunde - 06 Nov 2004   [ Top ] 

When you run Eclipse for the first time, it will prompt you for a repository location. Where you want to keep your QuArK CVS files. The default c:\eclipse\workspace is fine if you prefer.

Step 1) Set the Preferences: 

In the main menu of the program select Window > Preferences, expand the treeview to show Team > File Content, click the Add... button and add dfm, pas and dpr as ASCII files, add res as Binary file (add it first as ASCII, the default, then select it and click the "Change" button). Finally, click the OK button to close the Preferences window.

Step 2) Add a new CVS Repository: 

Switch to CVS Repository Exploring - By clicking the icon circled in red. Be sure the box to the right of the icon says Resource. If not, go ahead and click the same icon (circled in red) and select Resource, then click the same icon (circled in red) again and select CVS Repository Exploring.

Now click the Add CVS Repository icon also circled in red.

Step 3) Set the Add CVS Repository: 

Fill out the form with the information settings shown.

Host: cvs.sorceforge.net

Repository path: /cvsroot/quark

User: your registered sourceforge user name

Password: your registered password

Connection type: extssh

Use Default Port (selected)

Validate Connection on Finish (checked)

Save Password (checked)

Then click the Finish button to complete your connection to sourceforge.

Step 4) Viewing the sourceforge CVS files: 

After connecting, view the list of available modules by expanding the tree-view. The most current version files for QuArK are usually kept in the HEAD directory.


 Downloading Files

Rowdy / cdunde - 06 Nov 2004   [ Top ] 

Downloading a Module: 

Each folder is know as a Module of the program. To download a module, right-click it and select Check-out.

The modules required to build the QuArK program and support files are:

infobase  - used to build the help files.

runtime  - the program support files.

source  - the files used to build the QuArK.exe file.

This dialog is displayed while the module is being checked out and can be set to Run in Background.

Now switch to the Resource view to see the module files you have downloaded to your computer by clicking the icon circled in red.

The Resource View: 

Note that the ">" indicates that a file has been changed or added. You can press F5 to refresh the resource view to see what files you have changed.


 Uploading Files

Rowdy / cdunde - 06 Nov 2004   [ Top ] 

Committing Files: 

Commit a file means that you are uploading it.

To upload a file, right-click it, on the popup menu go to Team and then select Commit....

Note also the Synchronize with Repository option - this compares your local files with the files on the CVS server and shows you graphically the differences.

Just to reiterate, before you commit anything using Eclipse, make sure you ALWAYS go to the resource perspective, right-click on the modules you are going to commit (you can hold down the Ctrl key on the keyboard and left-click to select multiple files/directories), and select Refresh. Eclipse doesn't know that you have changed anything outside of Eclipse unless you tell it to refresh.

When you see what has changed (a ">" will be added in front of the directories and files that have changed), select everything that has changed (you can select each module, e.g. "source", "infobase" if you like), right-click again, select "Team" from the popup menu, and from the submenu select "Synchronize with Repository...".

That will compare your files with those in the repository, and show you any changes you have made that are outgoing, changes other people have committed that are incoming, and any conflicts (where someone has committed a file that you have also modified).

You can then select to commit all your outgoing changes, update all incoming changes, and you can double-click each conflicting file to see where the conflicts are, and to update your local file with changes made in the repository before you commit your file.

General Comments: 

If this information is of use, and a positive response is received about using Eclipse to access the QuArK source, Rowdy will probably expand on this with a few more examples, and hints on using Eclipse.



GNU General Public License by The QuArK (Quake Army Knife) Community - http://www.planetquake.com/quark

 [ Prev - Top - Next ]